Skip to content

carbonetes/jacked-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Carbonetes-Jacked Jacked-Action

GitHub Action: Jacked

Jacked provides organizations with a more comprehensive look at their application to take calculated actions and create a better security approach. Its primary purpose is to scan vulnerabilities to implement subsequent risk mitigation measures. GitHub Action CICD Integration.

Inputs Description

Input Name Description
scan-name * Input image name image:tag, tar file path, or directory path.
scan-type * Select Scan Type: image, tar, or directory.
fail-criteria * Input a severity that will be found at or above given severity([unknown negligible low medium high critical]). Default: medium.
skip-build-fail \ Default as false. Skip build to fail based on the assessment.
skip-db-update \ Skip Jacked Vulnerability Database Update.
ignore-package-names \ Ignore Package names when scanning... e.g. input: dpkg,tar,bash,...
ignore-cves \ Ignore CVES when scanning... e.g. input: CVE-2022-1271,CVE-2022-3715,CVE-2022-1664,...

* = required inputs.

File Permission

.jackedci.yaml file needs to be permitted(read, write, executable). To work with the following features:

Ignore Policy

  • ignore-package-names
  • ignore-cves

File Path .jackedci.yaml

Linux / MacOS File Path

/root/.jackedci.yaml

Windows OS File Path

{username}/.jackedci.yaml

Output Description

Table Description
SBOM Show a list of packages.
Vulnerability Scan Show list of vulnerabilities found.
Recommendation Show available recommendation to fix vulnerabilities.
Assessment Based on fail-criteria severity. Pass-Fail Assessment.

Pipeline Usage

name: Jacked Action
on: [push, pull_request]
jobs:
  jacked:
    runs-on: ${{matrix.os}}
    strategy:
      matrix:
        os: [ubuntu-latest] # can add more os: windows-latest, macOS-latest
    steps:
      - name: Checkout repository # Checkout user's current repository
        uses: actions/checkout@v3

      - name: Run carbonetes/jacked # runs the github action of jacked.
        uses: carbonetes/jacked@v1.2.0 # runs the github action using this version.
        with: # user’s input reference for scanning options, results that jacked-action supported.
          scan-name: "." # Image name, Tar File Path, or Directory Path. Required*
          scan-type: "." # Type "image", "tar", or "directory". Required*
          fail-criteria: "" # Optionally specify the minimum vulnerability severity to trigger an "error".  Valid choices are "negligible", "low", "medium", "high" and "critical". Required*
          skip-build-fail: # Set build is always success, ignore assessment result.
          skip-db-update: # Skip Jacked Vulnerability Database Update.
          ignore-package-names: # Ignore Package names when scanning... e.g. input: dpkg,tar,bash,...
          ignore-cves: # Ignore CVES when scanning... e.g. input: CVE-2022-1271,CVE-2022-3715,CVE-2022-1664,...

License

Apache 2.0